-
Notifications
You must be signed in to change notification settings - Fork 774
Migrate API reference to markdown #8501
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
barkbay
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
hack/api-docs/templates/gv_list.tpl
Outdated
| --- | ||
| mapped_pages: | ||
| - https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-api-reference.html | ||
| navigation_title: API reference |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit, for consistency?
| navigation_title: API reference | |
| navigation_title: API Reference |
(not 100% sure)
|
@pebrc :
I believe that's totally up to you to decide. In the If you think it's better to show all the content in the same page (like k8s api docs) I'm almost sure that's totally fine. |
I spent a bit more time on breaking up the single file. The tooling we have makes it hard to generate the grouping into files the way the migration has created them. I think I stick with a single file if that's OK for now. If we have more time to optimise this later we can think about breaking it up into single files per API kind. |
Part of #8498
https://docs-v3-preview.elastic.dev/elastic/cloud-on-k8s/pull/8501/reference/
Adjust the templating for the API reference. Markdown was modelled after #8496
Differences to the manually migrated files: API reference tool creates a single file not a file per group, we could however adjust that if needed.